Services

1. basic

basic.allapplicationsGiven a current expression, this service yields all rules that can be applied at a certain location, regardless wether the rule used is buggy or not. Some results are within the strategy, others are not.
basic.allfirstsReturns all next steps that are suggested by the strategy. See the onefirst service to get only one suggestion. For each suggestion, a new state, the rule used, and the location where the rule was applied are returned.
basic.applicable (deprecated)Given a current expression and a location in this expression, this service yields all rules that can be applied at this location, regardless of the strategy.
basic.applyApply a rule at a certain location to the current expression. If this rule was not expected by the strategy, we deviate from it. If the rule cannot be applied, this service call results in an error.
basic.createGiven an expression, this service returns an initial state with the original given expression.
basic.derivation (deprecated)See 'solution' service.
basic.diagnoseDiagnose an expression submitted by a student. Possible diagnosis are Buggy (a common misconception was detected), NotEquivalent (something is wrong, but we don't know what), Similar (the expression is pretty similar to the last expression in the derivation), Expected (the submitted expression was anticipated by the strategy), Detour (the submitted expression was not expected by the strategy, but the applied rule was detected), and Correct (it is correct, but we don't know which rule was applied).
basic.equivalenceTests whether two terms are semantically equivalent.
basic.exampleThis services returns a specific (numbered) example expresssion that can be solved with an exercise. These are the examples that appear at the page generated for each exercise. Also see the generate service, which returns a random start term.
basic.examplesThis services returns a list of example expresssions that can be solved with an exercise. These are the examples that appear at the page generated for each exercise. Also see the generate service, which returns a random start term.
basic.findbuggyrulesSearch for common misconceptions (buggy rules) in an expression (compared to the current state). It is assumed that the expression is indeed not correct. This service has been superseded by the diagnose service.
basic.finishedChecks whether a term is in solved form.
basic.generateGiven an exercise code and a difficulty level (optional), this service returns an initial state with a freshly generated expression.
basic.onefirstReturns a possible next step according to the strategy. Use the allfirsts service to get all possible steps that are allowed by the strategy. In addition to a new state, the rule used and the location where to apply this rule are returned.
basic.problemdecompositionStrategy service developed for the SURF project Intelligent Feedback for a binding with the MathDox system on linear algebra exercises. This is a composite service, and available for backwards compatibility.
basic.ready (deprecated)See 'finished' service.
basic.similarityTests whether two terms are (nearly) the same.
basic.solutionReturns one possible worked-out solution starting with the current expression. The first optional argument lets you configure the strategy, i.e., make some minor modifications to it. Rules used and intermediate expressions are returned in a list.
basic.stepsremainingComputes how many steps are remaining to be done, according to the strategy. For this, only the first derivation is considered, which corresponds to the one returned by the derivation service.
basic.submit (deprecated)Analyze an expression submitted by a student. Possible answers are Buggy, NotEquivalent, Ok, Detour, and Unknown. This service has been superseded by the diagnose service.
basic.suitableIdentifies which terms can be solved by the strategy.

2. meta

meta.examplederivationsShow example derivations
meta.exerciseinfoExercise information
meta.exerciselistReturns all exercises known to the system. For each exercise, its domain, identifier, a short description, and its current status are returned.
meta.indexIndex of the domain reasoner
meta.microstepsNext (minor) steps.
meta.ruleinfoInformation about a rule
meta.rulelistReturns all rules of a particular exercise. For each rule, we return its name (or identifier), whether the rule is buggy, and whether the rule was expressed as an observable rewrite rule. See rulesinfo for more details about the rules.
meta.rulesinfoReturns a list of all rules of a particular exercise, with many details including Formal Mathematical Properties (FMPs) and example applications.
meta.serviceinfoInformation about a feedback service
meta.servicelistList of all supported feedback services
meta.stateinfoState information
meta.strategyinfoReturns the representation of the strategy of a particular exercise.
meta.testreportShow test report for an exercise.

3. textual

textual.derivationtextSimilar to the derivation service, but the rules appearing in the derivation have been replaced by a short description of the rule.
textual.feedbacktextTextual feedback for diagnose service. Experimental.
textual.onefirsttextSimilar to the onefirst service, except that the result is now returned as a formatted text message. The optional string is for announcing the event leading to this service call (which can influence the returned result).
textual.submittext (deprecated)Similar to the submit service, except that the result is now returned as a formatted text message. The expression 'submitted' by the student is sent in plain text (and parsed by the exercise's parser). The boolean in the result specifies whether the submitted term is accepted and incorporated in the new state.